Skip to content

FIX: Add missing manuals for the tracked input devices components (ISXB-1410) #2152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 16 commits into from
Mar 28, 2025
Merged

FIX: Add missing manuals for the tracked input devices components (ISXB-1410) #2152

merged 16 commits into from
Mar 28, 2025
+39 −0

Conversation

@K-Tone
Copy link
Collaborator

@K-Tone K-Tone commented Mar 14, 2025 •
edited
Loading

Description

This pull request adds two new sections that were priorly missing and causing broken link reports.

Testing status & QA

This is purely a docs change really, nothing's really going to be broken all that much.

Overall Product Risks

  • Complexity: Low
  • Halo Effect: Low

Comments to reviewers

None.

Checklist

Before review:

  • Changelog entry added.
    • Explains the change in Changed, Fixed, Added sections.
    • For API change contains an example snippet and/or migration example.
    • JIRA ticket linked, example (case %%). If it is a private issue, just add the case ID without a link.
    • Jira port for the next release set as "Resolved".
  • Tests added/changed, if applicable.
    • Functional tests Area_CanDoX, Area_CanDoX_EvenIfYIsTheCase, Area_WhenIDoX_AndYHappens_ThisIsTheResult.
    • Performance tests.
    • Integration tests.
  • Docs for new/changed API's.
    • Xmldoc cross references are set correctly.
    • Added explanation how the API works.
    • Usage code examples added.
    • The manual is updated, if needed.

During merge:

  • Commit message for squash-merge is prefixed with one of the list:
    • NEW: ___.
    • FIX: ___.
    • DOCS: ___.
    • CHANGE: ___.
    • RELEASE: 1.1.0-preview.3.

After merge:

  • Create forward/backward port if needed. If you are blocked from creating a forward port now please add a task to ISX-1444.

@unity-cla-assistant
Copy link

unity-cla-assistant commented Mar 14, 2025 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@K-Tone K-Tone changed the title FIX: add docs for tracked pose input devices FIX: Add missing manuals for the tracked input devices components Mar 14, 2025
@K-Tone K-Tone requested a review from ekcoh March 14, 2025 15:01
@K-Tone K-Tone added the bug Issues where existsing functionality misbehaves label Mar 14, 2025
@K-Tone K-Tone marked this pull request as ready for review March 14, 2025 15:14
@K-Tone K-Tone force-pushed the anthony/ixsb-1410-add-tracked-device-input-docs branch from 0785f70 to 1f41d1e Compare March 14, 2025 15:14
@K-Tone K-Tone changed the title FIX: Add missing manuals for the tracked input devices components FIX: Add missing manuals for the tracked input devices components (ISXB-1410) Mar 14, 2025
@K-Tone K-Tone requested a review from JonMUnity March 15, 2025 15:02
ekcoh
ekcoh approved these changes Mar 17, 2025
View reviewed changes
Copy link
Collaborator

@ekcoh ekcoh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this documentation. I think it looks good and I believe it is good that it links further into the script Api documentation that already existed. Also great you added CHANGELOG entry. It makes sense that some feedback is received from XR side as well before landing this.

Pauliusd01
Pauliusd01 approved these changes Mar 18, 2025
View reviewed changes
Copy link
Collaborator

@Pauliusd01 Pauliusd01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds a bit "fluffy/marketingy" at times but overall fine to me

JonMUnity
JonMUnity reviewed Mar 18, 2025
View reviewed changes
Copy link
Collaborator

@JonMUnity JonMUnity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made some minor suggestions. Let me know if you have any questions!

K-Tone
K-Tone commented Mar 20, 2025
View reviewed changes
@K-Tone K-Tone force-pushed the anthony/ixsb-1410-add-tracked-device-input-docs branch from e37ba52 to 2ce537c Compare March 20, 2025 14:48
vrdave-unity
vrdave-unity approved these changes Mar 24, 2025
View reviewed changes
Copy link
Collaborator

@vrdave-unity vrdave-unity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good from my side. You might consider using xref: in the future for the API references from the manual, just in case any of the namespaces or structure moves around your doc references don't break.

K-Tone and others added 12 commits March 27, 2025 18:58
@K-Tone
fork existing docs to make room for two new sections for tracked inpu…
e0f1fa0 
…t devices
@K-Tone
moving text from gdocs, first pass
6fbf2d2
@K-Tone
links to api pages in the tracked pose driver section
52aa9c0
@K-Tone
add links in the raycaster section
2020356
@K-Tone
extra boldface
48a3bbf
@K-Tone
auto format
e1f9e33
@K-Tone
update changelog
4172f54
@K-Tone @chris-massie
Update Packages/com.unity.inputsystem/CHANGELOG.md
f838b0c 
Co-authored-by: Chris Massie <[email protected]>
@K-Tone @JonMUnity
Update Packages/com.unity.inputsystem/Documentation~/TrackedInputDevi…
fac54e9 
…ces.md

Co-authored-by: JonMUnity <[email protected]>
@K-Tone @JonMUnity
Update Packages/com.unity.inputsystem/Documentation~/TrackedInputDevi…
dd562ff 
…ces.md

Co-authored-by: JonMUnity <[email protected]>
@K-Tone @JonMUnity
Update Packages/com.unity.inputsystem/Documentation~/TrackedInputDevi…
54aa2bb 
…ces.md

Co-authored-by: JonMUnity <[email protected]>
@K-Tone @JonMUnity
Update Packages/com.unity.inputsystem/Documentation~/TrackedInputDevi…
b026bf9 
…ces.md

Co-authored-by: JonMUnity <[email protected]>
@K-Tone K-Tone force-pushed the anthony/ixsb-1410-add-tracked-device-input-docs branch from 414e550 to c837ea2 Compare March 27, 2025 15:58
@K-Tone K-Tone merged commit 36a93fe into develop Mar 28, 2025
110 checks passed
@K-Tone K-Tone deleted the anthony/ixsb-1410-add-tracked-device-input-docs branch March 28, 2025 10:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ekcoh ekcoh ekcoh approved these changes

@Pauliusd01 Pauliusd01 Pauliusd01 approved these changes

@vrdave-unity vrdave-unity vrdave-unity approved these changes

@JonMUnity JonMUnity JonMUnity approved these changes

@chris-massie chris-massie Awaiting requested review from chris-massie

Assignees

No one assigned

Labels

bug Issues where existsing functionality misbehaves

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@K-Tone @unity-cla-assistant @ekcoh @Pauliusd01 @chris-massie @vrdave-unity @JonMUnity